package ch.cyberduck.core.features;

/*
 * Copyright (c) 2002-2022 iterate GmbH. All rights reserved.
 * https://cyberduck.io/
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

import ch.cyberduck.core.Path;
import ch.cyberduck.core.exception.BackgroundException;
import ch.cyberduck.core.transfer.TransferStatus;

import java.io.InputStream;

@Optional
public interface Encryptor {

    /**
     * Wrap proxy with stream encrypting content on the fly
     *
     * @param file   File
     * @param proxy  File input stream
     * @param status Encryption properties
     * @return Wrapped stream
     */
    InputStream encrypt(Path file, InputStream proxy, TransferStatus status) throws BackgroundException;
}
